/*
 * Copyright (c) 2010-2011, okazoh_tk. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALKES_GRAPH_LAYER_H_INCLUDED_
#define ALKES_GRAPH_LAYER_H_INCLUDED_

#include "alkes/graph/Clippable.h"
#include "alkes/graph/Scene.h"

namespace alkes {

/// \addtogroup scenegraph
//@{

enum LayerBlendMode
{
    AL_LAYER_BLEND_OPACITY = 0, ///< result = src (Disabled alpha blend)
    AL_LAYER_BLEND_NORMAL,      ///< result = src * As + dst * (1 - As)
    AL_LAYER_BLEND_MULTIPLY,    ///< result = src * dst
    AL_LAYER_BLEND_SCREEN,      ///< result = src + dst
};

class AL_GRAPH_EXPORT Layer
    : public Clippable
{
    AL_DECLARE_ELEMENT(Layer, Clippable);

public:
    Layer();
    virtual ~Layer();

    Scene* registerScene(Scene* scene);
    void removeScene(Scene* scene);

    void setOpacity(int16_t opacity);
    int16_t getOpacity() const;

    void setLayerBlendMode(LayerBlendMode mode);
    LayerBlendMode getLayerBlendMode() const;

    bool update(UpdateContext& uc);
    void render(GraphicsContext& gc, const Rect& render_rect);

protected:
    virtual bool onPreRender(GraphicsContext& gc);
    virtual void onPostRender(GraphicsContext& gc);

    void setAlphaBlendMode(IGraphics2DDevice* device);

    bool updateChildren(UpdateContext& uc);
    void renderChildren(GraphicsContext& gc);

private:
    void removeAllScene();

private:
//    GraphicsContext graphics_context_;
//    UpdateContext update_context_;
    ElementContainer scene_list_;
    int16_t opacity_;
    int16_t opacity_backup_;
    LayerBlendMode layer_blend_mode_;
};

//@}

}

/// \addtogroup scenegraph
//@{

template<class T>
T* alkes_registerScene(alkes::Layer* layer)
{
    return static_cast<T*>(layer->registerScene(new T()));
}

template<class T, class U>
T* alkes_registerScene(alkes::Layer* layer, U p0)
{
    return static_cast<T*>(layer->registerScene(new T(p0)));
}

template<class T, class U, class V>
T* alkes_registerScene(alkes::Layer* layer, U p0, V p1)
{
    return static_cast<T*>(layer->registerScene(new T(p0, p1)));
}

template<class T>
T* alkes_registerScene2D(alkes::Layer* layer)
{
    return static_cast<T*>(layer->registerScene(new T()));
}

template<class T, class U>
T* alkes_registerScene2D(alkes::Layer* layer, U p0)
{
    return static_cast<T*>(layer->registerScene(new T(p0)));
}

template<class T, class U, class V>
T* alkes_registerScene2D(alkes::Layer* layer, U p0, V p1)
{
    return static_cast<T*>(layer->registerScene(new T(p0, p1)));
}

//@}

#endif
